/********************************************************************************
 * Copyright 2009 The Robotics Group, The Maersk Mc-Kinney Moller Institute,
 * Faculty of Engineering, University of Southern Denmark
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ********************************************************************************/

#ifndef RW_SENSOR_SENSORDATA_HPP
#define RW_SENSOR_SENSORDATA_HPP

namespace rw { namespace sensor {

    /** @addtogroup sensor */
    /* @{ */

    /**
     * @brief toplevel class for sensor data. Basicly describes interface for
     * setting and getting timestamps.
     */
    class SensorData
    {
      public:
        /**
         * @brief constructor
         * @param timeStamp
         */
        SensorData (long timeStamp = 0) : _stamp (timeStamp) {}

        /**
         * @brief Destructor
         */
        virtual ~SensorData () {}

        /**
         * @brief get timestamp of this sensor data
         * @return timestamp in ms
         */
        virtual long getTimeStamp () { return _stamp; }

        /**
         * @brief set timestamp of this sensor data
         * @param timestamp [in] time in ms
         */
        virtual void setTimeStamp (long timestamp) { _stamp = timestamp; }

      private:
        long _stamp;
    };

    /* @} */
}}    // namespace rw::sensor

#endif /* RW_SENSOR_SENSORDATA_HPP */
